home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 033a / wafdl110.zip / WAFDL.DOC < prev    next >
Text File  |  1991-06-05  |  14KB  |  529 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.                                         WAFDL
  32.                                   by Andrew Rossmann
  33.                                      Version 1.00
  34.                                      June 4, 1991
  35.                                andyross@infopls.mcs.com
  36.               Infoplus BBS, +1 708 537 0247, running Waffle BBS software
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.                                   WAFDL version 1.00
  74.           requirements:
  75.             DOS 2.0 or later
  76.             Omen Technologies' DSZ.COM or DSZ.EXE
  77.             21K free RAM, plus enough memory for DSZ.COM or DSZ.EXE to run
  78.  
  79.           options:
  80.             Waffle BBS software
  81.  
  82.               WAFDL is Copyright 1991 Andrew Rossmann, All Rights Reserved
  83.  
  84.             WAFDL is free for use. It must be distributed with all
  85.           documentation and programs intact and unmodified. The .ZIP
  86.           version must contain my Authenticity Verification number.
  87.  
  88.             Authentic files Verified!   # XNW068   Andrew Rossmann
  89.  
  90.             WAFDL is a utility for Waffle BBS's (and possibly others) that
  91.           is a very simple way for people to download files without using
  92.           Waffle's very confusing FILES section.
  93.  
  94.             Some of the uses for WAFDL are:
  95.  
  96.               -  Provide files for NEWUSERS to download, like USER.DOC,
  97.                  TIPS, etc..
  98.  
  99.               -  Create a command for downloading related types of files,
  100.                  like Waffle utilities.
  101.  
  102.               -  By marking the command as a 'shell' for a login, no access
  103.                  to the BBS takes place. This clears up clutter and
  104.                  unneeded users. Your guests don't get lost trying to find
  105.                  things!!
  106.  
  107.             WAFDL lets Waffle do all of the serial port redirection. With
  108.           all the possible combinations available today, putting it into
  109.           the program would make configuration much more difficult. In
  110.           fact, when DSZ is running, WAFDL actually redirects standard
  111.           output back to the screen! (Since Waffle is most likely taking
  112.           over DOS calls to do it's redirection, maybe a future version
  113.           could add some sort of extended function call that would let you
  114.           turn redirection on and off, amongst other nice things.)
  115.  
  116.             You need to do three (or four) things to get WAFDL up and
  117.           running:
  118.  
  119.              1.  Install WAFDL.EXE on your disk
  120.  
  121.              2.  Create information files for each command
  122.  
  123.              3.  Create command files in /WAFFLE/EXTERN
  124.  
  125.              4.  (optional) Create a special account with the new command
  126.                  as the shell.
  127.  
  128.  
  129.  
  130.                                         - 2 -
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.                                     INSTALLING WAFDL
  140.  
  141.             The best place to put WAFDL.EXE is /WAFFLE/BIN. That's where
  142.           every other program goes. You could put it elsewhere, buy why
  143.           make things confusing? There is nothing fancy to do, just copy it
  144.           there.
  145.  
  146.                                CREATE AN INFORMATION FILE
  147.  
  148.             An information file is simply an ASCII text file full of
  149.           commands. There aren't very many commands to learn.
  150.  
  151.           $ADMIN=path   File to hold information on when WAFDL is invoked,
  152.                         answers to any questions asked, and what files were
  153.                         downloaded. This should be a complete pathname. If
  154.                         you place it in the /WAFFLE/ADMIN directory, you
  155.                         can use the SHOW command to view it.
  156.                         ex: $ADMIN=C:\WAFFLE\ADMIN\NEWUSER.
  157.  
  158.           $ASKn=text    (optional) WAFDL will display the text, and then
  159.                         wait for a response. 'n' is the minimum length you
  160.                         want to allow. The default is 0. The maximum is
  161.                         255. Anything longer than 255 will default to 3.
  162.                         Unknown text (ASKZZ=) will default to 0.
  163.                         Questions will be asked in the order they are found
  164.                         in the file.
  165.                         Questions must be on one line, up to 255 characters
  166.                         total (including the $ASKn=).
  167.                         If you use a Y instead, WAFDL will append on a '<Y>
  168.                         or <N>.=>', and only accept a 'Y' or 'N'.
  169.                         ex: ASK3=What is your name?
  170.                               The user must enter at least 3 characters
  171.                         ex: ASK=Who are you?
  172.                               The user can simply hit <ENTER>.
  173.                         ex: ASKY=Are you here?
  174.                               Will display 'Are you here? <Y> or <N>.=>'
  175.                         ex: ASK255=Give me an essay.=>
  176.                               Requires a really LONG answer!!
  177.  
  178.           $CLOSETEXT    Text shown when WAFDL is exiting normally.
  179.                         Mark the end of text with the word $END on a line
  180.                         by itself.
  181.                         The text will be paginated, based on 24 lines/page,
  182.                         if necessary.
  183.                         At the 'more' prompt, the user can skip the rest of
  184.                         the text, or even exit WAFDL immediately.
  185.                         ex:   $CLOSETEXT
  186.                                    Good bye!!
  187.                               $END
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.                                         - 3 -
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.           $DSZ          (optional) The path and program name to call up
  206.                         DSZ.
  207.                         WAFDL always uses 'CON port ? s? filename' as
  208.                         parameters (where '?' can vary.) The standard
  209.                         protocols used are:
  210.                         Zmodem - sz
  211.                         Ymodem Batch - sb
  212.                         1K-Xmodem - sx -k
  213.                         Xmodem - sx
  214.                         If you need to supply extra parameters for the
  215.                         proper functioning of DSZ, place them after the
  216.                         path. You can have two different sets, separated by
  217.                         the '|' character. Text before the '|' will be
  218.                         before the s? command. Text after the '|' will come
  219.                         after it (and will be used for ALL protocols!)
  220.                         ex:   DSZ=C:\WAFFLE\BIN\DSZ.COM
  221.                                    Will call DSZ with no special changes.
  222.                               DSZ=C:\WAFFLE\BIN\DSZ.COM pB8192
  223.                               'CON port ? pB8192 s? filename'
  224.                               DSZ=C:\WAFFLE\BIN\DSZ.COM pB8192|-m
  225.                               'CON port ? pB8192 s? -m filename'
  226.                               DSZ=C:\WAFFLE\BIN\DSZ.COM |-m
  227.                               'CON port ? s? -m filename'
  228.  
  229.           $END          Must be on a line by itself to mark the end of an
  230.                         $OPENTEXT or $CLOSETEXT line.
  231.  
  232.           $FILE         (optional) Contains a two-line entry giving a
  233.                         prompt line, and the filepath. You can have up to 9
  234.                         files. They will be numbered in the order they are
  235.                         found in the file. Each file you want available
  236.                         should have it's own $FILE block.
  237.                         If no $FILE's are found, WAFDL will exit and
  238.                         display $CLOSETEXT.
  239.                         ex:   $FILE
  240.                               THISFILE - A big file! 1,234,252,837 bytes.
  241.                               C:\PUBLIC\BIGSTUF\THISFILE
  242.                               $FILE
  243.                               SMALLFIL - A small file! 1 byte.
  244.                               C:\PUBLIL\SMALLSTF\SMALLFIL
  245.                                    The above would make 2 files available
  246.                         for downloading.
  247.  
  248.           $OPENTEXT     Text shown when WAFDL starts up.
  249.                         Mark the end of text with the word $END on a line
  250.                         by itself.
  251.                         The text will be paginated, based on 24 lines/page,
  252.                         if necessary.
  253.                         At the 'more' prompt, the user can skip the rest of
  254.                         the text, or even exit WAFDL immediately.
  255.                         ex:   $OPENTEXT
  256.                                    Hello there!
  257.                               $END
  258.  
  259.  
  260.  
  261.  
  262.                                         - 4 -
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.                                  CREATING COMMAND FILE
  272.  
  273.             WAFDL requires 4 parameters, in order:
  274.  
  275.              1.  Port in use (a number)
  276.  
  277.              2.  Baud rate (not currently used)
  278.  
  279.              3.  Path to information file
  280.  
  281.              4.  Userid calling WAFDL
  282.  
  283.             For each 'command' you want to create, you need to create a
  284.           file in /WAFFLE/EXTERN. The file name is the name of the command
  285.           you want. Each one should contain something along these lines:
  286.  
  287.             /command="C:\WAFFLE\BIN\WAFDL %d %b c:\public\infofile %A"
  288.  
  289.             If you are using Waffle 1.64 or newer, and WAFDL is in
  290.           \WAFFLE\BIN (or the directory defined as bin in the STATIC file),
  291.           then you do not need to specify the path.
  292.  
  293.             Since WAFDL uses Waffle to handle redirection (except when DSZ
  294.           is running), there is no need to use /screen or other parameters.
  295.  
  296.             You can create any number of commands. Just place them in
  297.           /WAFFLE/EXTERN
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.                                         - 5 -
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.                             CREATING A LOGON LINKED COMMAND
  338.  
  339.             There are two ways to have WAFDL called when a user logs in.
  340.           What method you use depends on whether you want the user to have
  341.           access to the BBS or not.
  342.  
  343.             If you want the user to have access to the BBS after WAFDL
  344.           finishes, then create a WAFFLE file in that login accounts' user
  345.           directory. Place the command (or commands) you want executed on
  346.           separate lines in that file.  If the account is a general access
  347.           account like GUEST, it's a good idea to mark the file read-only
  348.           to prevent someone from changing it. (ATTRIB +R WAFFLE)
  349.  
  350.             If you want the account to only run WAFDL, you will need to use
  351.           the 'ADMIN X accountname' command. One of the entries is for
  352.           shell. If you make this the WAFDL external command, Waffle will
  353.           log the user off when WAFDL finishes (or aborts, or carrier is
  354.           lost.) If you want to create an account with no password, use the
  355.           regular 'ADMIN EDIT accountname' command, and change the password
  356.           to a single space.
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.                                         - 6 -
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.                                      THE ADMIN FILE
  404.  
  405.             Whenever WAFDL is called (with a valid infofile), it writes
  406.           selected information to the file defined by $ADMIN. This includes
  407.           invocation date/time/user, answers to questions, errors found,
  408.           and files transferred.
  409.  
  410.             A sample:
  411.           -----
  412.           WAFDL activated 6/4/1991 at 19:20:52 by andyross
  413.           Andrew Rossmann
  414.           Wheeling, IL
  415.           Y
  416.           Downloaded C:\tp\infoplus\IFP1P145.ZIP using Z result was 0
  417.           Downloaded I:\IFP1S145.ZIP using X result was 0
  418.           -----
  419.           WAFDL activated 6/4/1991 at 19:23:6 by andyross
  420.           Exited WAFDL in reader!
  421.           -----
  422.           WAFDL activated 6/4/1991 at 19:31:5 by andyross
  423.           Andrew Rossmann
  424.           Wheeling, IL
  425.           Y
  426.           ERROR: DosErr 2
  427.           DSZpath: C:\tp\programs\dsz
  428.           cmdline: CON port 2  sz  C:\tp\infoplus\IFP1P145.ZIP
  429.  
  430.             In the first entry, things went fine. The first question asked
  431.           for the name, and the second where they are. The third was a
  432.           Yes/No question. Two file were then successfully downloaded. The
  433.           first using Zmodem, and the second using Xmodem.
  434.             In the second entry, the user decided to exit WAFDL at a more
  435.           prompt during $OPENTEXT.
  436.             In the third entry, things went fine until the user tried to
  437.           download. It seems as if the DSZ path is invalid (it should be
  438.           dsz.com)
  439.  
  440.             It's very recommended that you test out any changes to your
  441.           information files. An error can really confuse and disappoint
  442.           your callers.
  443.  
  444.             When DSZ is called, screen text will output using inverse video
  445.           (black on white.) This lets you know that standard output is
  446.           being redirected (or should that be un-directed!)
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.                                         - 7 -
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.             If you have any problems using WAFDL, or suggestions, I can be
  470.           reached at the Infoplus BBS, +1 708 537 0247.
  471.  
  472.             Internet: andyross@infopls.mcs.com
  473.             UUCP    : uunet!infopls!andyross
  474.  
  475.             If you call the Infoplus BBS, you can see WAFDL in action. If
  476.           you logon as INFOPLUS, you can see the linked usage. If you logon
  477.           as GUEST, you can try the INFOPLUS, NEWUSER, and WAFLSTUF
  478.           commands. WAFLSTUF will also let you download the latest version
  479.           of WAFDL, in addition to other Waffle utilities. Since WAFDL is
  480.           limited to 9 file, you can also look in /public/waflstuf to see
  481.           if there are more.
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.                                         - 8 -
  527.  
  528.  
  529.